/**
 * Copyright (c) 2010 Simple Graph Tools contributors. All rights reserved.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * $Id$
 */
package org.sgt.coredef.util;

import java.util.Map;
import java.util.Set;

import org.eclipse.emf.common.util.EList;
import org.sgt.coredef.Node;



/**
 * Just a tagging interface for Sequenced Graph objects.
 * @author Anne BUTTIGHOFFER
 *
 */
public interface IGraphSequence {

	/**
	 * @return the sequenced graph : a set of ordered nodes
	 * list for each of the routes of interest.
	 */
	Map<Route, Set<EList<Node>>> getEmbeddedObject();
	
	/**
	 * Sets the sequenced graph : a set of ordered nodes
	 * list for each of the routes of interest of this graph sequence.
	 * @param object {@link Map<Route, Set<EList<Node>>>}.
	 */
	void setEmbeddedObject(Map<Route, Set<EList<Node>>> object);
	
	/**
	 * @return the user friendly string representation of
	 * a graph sequence.
	 */
	String stringRepresentation();
}
